From 42117fa82b30d3bce1f30c3337e63dbe3d34da59 Mon Sep 17 00:00:00 2001
From: parkrrrr <parkrrrr>
Date: Fri, 19 May 2006 20:28:30 +0000
Subject: [PATCH] Change the way we link to appendices (xref instead of link)
 Document xcsv's options, since they're used so many places.

---
 xmldoc/formats/custom.xml                         | 2 +-
 xmldoc/formats/options/garmin_txt-datum.xml       | 2 +-
 xmldoc/formats/options/xcsv-prefer_shortnames.xml | 8 +++++++-
 xmldoc/formats/options/xcsv-snlen.xml             | 7 +++++++
 xmldoc/formats/options/xcsv-snunique.xml          | 7 +++++++
 xmldoc/formats/options/xcsv-snupper.xml           | 7 +++++++
 xmldoc/formats/options/xcsv-snwhite.xml           | 8 +++++++-
 xmldoc/formats/options/xcsv-style.xml             | 9 +++++++++
 xmldoc/formats/options/xcsv-urlbase.xml           | 6 +++++-
 xmldoc/formats/tabsep.xml                         | 3 +--
 10 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/xmldoc/formats/custom.xml b/xmldoc/formats/custom.xml
index 40cbece72..fdb1ef7e9 100644
--- a/xmldoc/formats/custom.xml
+++ b/xmldoc/formats/custom.xml
@@ -5,5 +5,5 @@ for debugging purposes when developing a new format module for GPSBabel.
 <para>
 To understand the contents of this file, look at the 
 <filename>style/custom.style</filename> file in the GPSBabel source
-distribution as well as the <link linkend="app_styles">appendix</link>.
+distribution as well as <xref linkend="Styles" />.
 </para>
diff --git a/xmldoc/formats/options/garmin_txt-datum.xml b/xmldoc/formats/options/garmin_txt-datum.xml
index f31c58d79..ce1cadb23 100644
--- a/xmldoc/formats/options/garmin_txt-datum.xml
+++ b/xmldoc/formats/options/garmin_txt-datum.xml
@@ -1,4 +1,4 @@
 <para>
 This option specifies the datum to be used on output.  Valid values for this 
-option are listed in <link linkend="Datums">the appendix</link>.
+option are listed in <xref linkend="Datums" />.
 </para>
diff --git a/xmldoc/formats/options/xcsv-prefer_shortnames.xml b/xmldoc/formats/options/xcsv-prefer_shortnames.xml
index 8b1378917..e3103bd2d 100644
--- a/xmldoc/formats/options/xcsv-prefer_shortnames.xml
+++ b/xmldoc/formats/options/xcsv-prefer_shortnames.xml
@@ -1 +1,7 @@
-
+<para>
+This option causes GPSBabel to use the short name of the waypoint instead
+of the description.  This overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
diff --git a/xmldoc/formats/options/xcsv-snlen.xml b/xmldoc/formats/options/xcsv-snlen.xml
index 8b1378917..9318463ce 100644
--- a/xmldoc/formats/options/xcsv-snlen.xml
+++ b/xmldoc/formats/options/xcsv-snlen.xml
@@ -1 +1,8 @@
+<para>
+This option specifies the maximum allowable length for a short name on
+output.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
diff --git a/xmldoc/formats/options/xcsv-snunique.xml b/xmldoc/formats/options/xcsv-snunique.xml
index 8b1378917..1687cbec1 100644
--- a/xmldoc/formats/options/xcsv-snunique.xml
+++ b/xmldoc/formats/options/xcsv-snunique.xml
@@ -1 +1,8 @@
+<para>
+When this option is specified, GPSBabel will ensure that all short names are
+unique within the output file.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
diff --git a/xmldoc/formats/options/xcsv-snupper.xml b/xmldoc/formats/options/xcsv-snupper.xml
index 8b1378917..99400ee91 100644
--- a/xmldoc/formats/options/xcsv-snupper.xml
+++ b/xmldoc/formats/options/xcsv-snupper.xml
@@ -1 +1,8 @@
+<para>
+When this option is specified, GPSBabel will make all short names contain
+only UPPERCASE characters.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
diff --git a/xmldoc/formats/options/xcsv-snwhite.xml b/xmldoc/formats/options/xcsv-snwhite.xml
index 8b1378917..1688f0bc9 100644
--- a/xmldoc/formats/options/xcsv-snwhite.xml
+++ b/xmldoc/formats/options/xcsv-snwhite.xml
@@ -1 +1,7 @@
-
+<para>
+When this option is specified, GPSBabel will allow whitespace (spaces or tabs)
+in generated short names.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
diff --git a/xmldoc/formats/options/xcsv-style.xml b/xmldoc/formats/options/xcsv-style.xml
index 8b1378917..43baf0378 100644
--- a/xmldoc/formats/options/xcsv-style.xml
+++ b/xmldoc/formats/options/xcsv-style.xml
@@ -1 +1,10 @@
+<para>
+This option specifies the style file that defines the records to be read on
+input or written on output.  This is not a valid option for the various
+built-in xcsv-based styles; they have prebuilt style definitions.
+</para>
+<para>
+For information on the format of xcsv style files, see 
+<xref linkend="Styles" />.
+</para>
 
diff --git a/xmldoc/formats/options/xcsv-urlbase.xml b/xmldoc/formats/options/xcsv-urlbase.xml
index 8b1378917..781e75c4c 100644
--- a/xmldoc/formats/options/xcsv-urlbase.xml
+++ b/xmldoc/formats/options/xcsv-urlbase.xml
@@ -1 +1,5 @@
-
+<para>
+This option specifies the base name to prepend to a URL on output.  This 
+might be useful if an input file contains URLs in a relative format and you
+need them to be in an absolute format.
+</para>
diff --git a/xmldoc/formats/tabsep.xml b/xmldoc/formats/tabsep.xml
index 42c6c1136..04f7d1fcf 100644
--- a/xmldoc/formats/tabsep.xml
+++ b/xmldoc/formats/tabsep.xml
@@ -3,8 +3,7 @@ This format, like the <link linkend="fmt_custom">custom</link> format, is
 mainly used for the purpose of testing GPSBabel.  It is supposed to contain
 one field for each piece of information supported by the 
 <link linkend="fmt_xcsv">xcsv</link> format writer, but it may not be entirely
-in sync with the <link linkend="app_styles">appendix</link> that describes 
-those fields.
+in sync with the documentation at <xref linkend="Styles" />.
 </para>
 <para>
 For a list of fields, see the style/tabsep.style file in the GPSBabel source
-- 
2.30.2